Quickbook API

(0 reviews)

Requesting a price quote

POST /quote/price

Description

Get a price and arrival time quote for a specific journey. Multiple services can be passed in as an array.

Authorization

The Authorization header carried the API access token in the format AL client_id:client_secret. Please see Security page for more information.

Content Type

application/json

Request

{
    "pickup_dt": "2023-10-25T09:00:00+01:00",
    "promo_code": "DISCOUNT10",
    "payment_method": "Account",
    "services": [
        {
            "code": "standard_car"
        },
        {
            "code": "exec_car"
        }
    ],
    "locations": [
        {
            "source": "Address",
            "street_address": "Barbican Centre, 10 Silk St",
            "town": "London",
            "postcode": "EC2Y 8DS",
            "country": "GB",
            "lat": 51.520024,
            "long": -0.092447,
            "notes": "Wait before the car park and taxis entrance"
        },
        {
            "source": "Airport",
            "street_address": "London Heathrow Airport",
            "lat": 51.47138888,
            "long": -0.45277777,
            "airport": {
                "iata": "LHR",
                "terminal": "2",
                "flight_number": "BA714",
                "arrival_from": "LAX"
            }
        }
    ]
}

Parameters	Description	Required?
pickup_dt	The date of the pickup. If omitted, then the journey is treated as ASAP	No
promo_code	The promo code to be used for the journey	No
payment_method	The payment method to be used for the journey. Valid values: `Account`, `MultiAccount` See Dev Guides / Multi-account	Yes
services.code	An array of predefined codes of services available for which a quote is required. See Dev Guides / Passenger and courier service types	Yes
locations	Array of locations. See Dev Guides / Building the locations array	Yes
as_directed	The destinations are pointed by the customer in the course of the trip. The possible values are `true` or `false`. If `"as_directed": true` the request message can have only one location.	No
as_directed_hours	The period of time (in hours) in which the car is hired. `Numeric`	Required if `"as_directed" : true`
destination_unknown	The customer does not specify the final location for the trip. This value is independent of `as_directed`, and `as_directed_hours`. The possible values are `true` or `false`. If `"destination_unknown": true` the request message can have only one location.	No

[1] required if the parent object is present

Response

{
  "request_id": "158aba9c-e8c8-42cc-ae79-b9324899ac94",
  "quotes": [
    {
      "quote_id": "57ba81a3-2a5a-4d69-b5e3-8cea49d5dfbb",
      "service": "standard_car",
      "total_price": 30,
      "price": 30,
      "discount": 0,
      "vat": 0,
      "currency": "GBP",
      "eta": "00:10:00"
    },
    {
      "quote_id": "75e086ab-c1b7-43c1-ae12-9435fa32053e",
      "service": "exec_car",
      "total_price": 45,
      "price": 45,
      "discount": 0,
      "vat": 0,
      "currency": "GBP",
      "eta": "00:15:00"
    }
  ]
}